fix: expose types in package #516
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey @namack, thanks for opening this PR. I do think adding a build is preferable. It should be pretty straightforward, we can make use of // [vite.config.js](https://github.com/imgix/vue/blob/9aebc6f129422ed21a9272f1a7e3fd9b3207794e/vite.config.js#L41)
import dts from 'vite-plugin-dts';
// ...
export default defineConfig({
// ...
plugins: [vue(), dts({ rollupTypes: true })],
// generates imgix-vue.esm.d, imgix-vue.min.d
})If you're interested in tackling this change yourself, let us know and we can assign an issue to you. In the meantime, we'll make this change as soon as someone on the team has the bandwidth. |
3 tasks
3 tasks
|
@luqven Great! Yes, this is definitely a less hacky solution 😄. I don't mind implementing the change, feel free to assign an issue to me. |
3 tasks
|
Closing in favor of using build step to bundle |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This exposes the typescript declaration files for typescript to reference when used in a project. This is the simplest way to accomplish this since the plugin type files are already included in the package. However, a more involved solution would be to add a build step for the compiled types to be included in the
/distdirectory.Before this PR typescript users would run into type errors while importing the package:
After this PR, typescript will automatically infer the types for the exported functions/classes:
Checklist